4.2.4.3 查询用户详情-基于外部id
可通过此接口在用户目录查询用户详情。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/user/queryByExternalId请求方式：
GET
请求头（Header）
- 请求参数（Query）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@） |
| externalId | 外部id | 是 | string | 用户外部 id |
- 请求示例
curl --location --request GET 'https://SDPC-IP:4433/api/v3/user/queryByExternalId?directoryDomain=custom01339&externalId=user-extid-zhangsan' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--header 'Cookie: locale=zh-cn'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| ├─ id | 用户id | string | 例如：1345c177-e4f6-11ee-835b-fefcfeefe529 |
| ├─ name | 用户名称 | string | 例如：张三 |
| ├─ groupId | 组织架构id | string | 例如：234d1caf-e4fe-11ee-bee9-fefcfeefe529 |
| ├─ groupPath | 组织架构路径 | string | 例如：/客服体系/专家中心/零信任专家组 |
| ├─ description | 描述 | string | |
| ├─ displayName | 显示名 | string | |
| ├─ externalId | 外部id | string | 例如：81dc9bdb52d04dc2 |
| ├─ inheritGroup | 是否继承组织架构的应用授权 | number | 取值范围：0-不继承1-继承 |
| ├─ phone | 手机号 | string | |
| ├─ status | 启用状态 | number | 取值范围：0-禁用1-启用 |
| 邮箱 | string | ||
| ├─ expiredTime | 过期时间 | string | 毫秒级别的Unix时间戳 示例： 时间戳：1710745688563 |
| ├─ isDeleted | 是否外部已删除 | number | 取值范围：0-否1-是 |
| ├─ resourceIdList | 关联应用id列表 | string[] | 示例： [ "08975347-e68b-4c15-b4f3-93eb8fbfd101", "47fc233a-c620-4fd1-88e2-290f8918ccdd" ] |
| ├─ resourceGroupIdList | 关联应用分类id列表 | string[] | 示例： [ "cb818f04-2271-43ad-b103-0241d92597cc", "86ed36d9-833f-4167-8320-61a03afb09c9" ] |
| ├─ roleIdList | 关联角色id列表 | string[] | 示例： [ "1d323967-9bdd-4561-ba44-e556821c2db1", "e54ac72a-6a71-433f-b25f-90e5763977f3" ] |
| ├─ authComposeId | 认证策略id | string | 示例： 17483500-e524-11ee-bee9-fefcfeefe529 |
| ├─ userPolicyId | 用户策略id | string | 示例： 182eb670-e524-11ee-bee9-fefcfeefe529 |
| ├─ dataSource | 用户数据来源 | object | 仅外部用户有此参数 |
| ├─├─ status | 启用状态来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
| ├─├─ phone | 手机号来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
| 邮箱来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
|
| ├─├─ expiredTime | 过期时间来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
| ├─├─ description | 描述来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
| ├─├─ displayName | 显示名来源 | string | 取值范围：local-从本地配置获取server-从用户目录同步和从认证服务器获取 |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"id": "d8ab0f70-b8fd-11ee-8e5e-4d44b4d649f0",
"name": "张三",
"groupId": "cc9bc63e-863a-42ff-990c-8bd63467cf5f",
"groupPath": "/",
"description": "通过openApi v3 创建",
"displayName": "张三-zhangsan",
"externalId": "user-extid-zhangsan",
"inheritGroup": 0,
"phone": "12312341234",
"status": 1,
"email": "zhangsan@xxx.com",
"expiredTime": "0",
"isDeleted": 0,
"resourceIdList": [
"080541f0-d4ee-11ec-9fe6-23abd5e79ce7",
"08212e60-d4ee-11ec-9fe6-23abd5e79ce7"
],
"resourceGroupIdList": [
"default"
],
"authComposeId": "",
"userPolicyId": "",
"dataSource": {
"status": "server",
"path": "local",
"phone": "server",
"email": "server",
"expiredTime": "server",
"description": "server",
"displayName": "server"
}
},
"msg": "请求成功",
"traceId": "00c3f630f5e03869"
}
错误码